RectInIconID

RectInIconID
Header:	Icons.h		Carbon status:	Supported

Hit-tests a rectangle against the appropriate icon mask from an icon family for a specified destination rectangle and alignment.

Boolean RectInIconID (
    const Rect *testRect, 
    const Rect *iconRect, 
    IconAlignmentType align, 
    SInt16 iconID
);

testRect: A pointer to the rectangle to be tested, specified in local coordinates of the current graphics port.
iconRect: A pointer to the rectangle in which the icon appears, specified in local coordinates of the current graphics port. The rectangle which you specify here should be the same rectangle that you last used to draw the icon. Like the PtInIconID function, this function determines, from the size of the rectangle specified in this parameter, which icon mask from the icon family to test the testRect parameter against.
align: Specifies how the icon against which to hit-test is aligned within the rectangle specified by iconRect. The alignment which you specify here should be the same alignment that you last used to draw the icon. See “Alignment Type Values” for a description of the values you can use in this parameter.
iconID: A resource ID for an icon family. In general, you should specify your icon resources as purgeable.

function result: TRUE if the rectangle intersects the icon and FALSE if it doesn’t.

SPECIAL CONSIDERATIONS

This function may move or purge memory blocks in the application heap. For that reason, your application should not call it at interrupt time.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when InterfaceLib 7.1 or later is installed. Exported by CarbonLib 1.0 and later and by InterfaceLib 7.1 and later.